Improve doc of gtk_text_buffer_paste_clipboard()
authorSébastien Wilmet <swilmet@gnome.org>
Sat, 14 Sep 2013 23:07:36 +0000 (01:07 +0200)
committerSébastien Wilmet <swilmet@gnome.org>
Mon, 16 Sep 2013 07:48:24 +0000 (09:48 +0200)
It didn't explain the behavior when there is a non-empty buffer
selection.

https://bugzilla.gnome.org/show_bug.cgi?id=339539

gtk/gtktextbuffer.c

index de91b756b3efd194ee6f38d972bdce18b92ce0c7..852b464e8aa029b749c4c6c67a45df016405e1bf 100644 (file)
@@ -3764,14 +3764,16 @@ remove_all_selection_clipboards (GtkTextBuffer *buffer)
  * gtk_text_buffer_paste_clipboard:
  * @buffer: a #GtkTextBuffer
  * @clipboard: the #GtkClipboard to paste from
- * @override_location: (allow-none): location to insert pasted text, or %NULL for
- *                     at the cursor
+ * @override_location: (allow-none): location to insert pasted text, or %NULL
  * @default_editable: whether the buffer is editable by default
  *
- * Pastes the contents of a clipboard at the insertion point, or
- * at @override_location. (Note: pasting is asynchronous, that is,
- * we'll ask for the paste data and return, and at some point later
- * after the main loop runs, the paste data will be inserted.)
+ * Pastes the contents of a clipboard. If @override_location is %NULL, the
+ * pasted text will be inserted at the cursor position, or the buffer selection
+ * will be replaced if the selection is non-empty.
+ *
+ * Note: pasting is asynchronous, that is, we'll ask for the paste data and
+ * return, and at some point later after the main loop runs, the paste data will
+ * be inserted.
  **/
 void
 gtk_text_buffer_paste_clipboard (GtkTextBuffer *buffer,